docs: update CRD docs #132
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
conformance test reportapiVersion: gateway.networking.k8s.io/v1
date: "2025-05-20T08:52:57Z"
gatewayAPIChannel: standard
gatewayAPIVersion: v1.2.0
implementation:
contact: null
organization: APISIX
project: apisix-ingress-controller
url: https://github.com/apache/apisix-ingress-controller.git
version: v2.0.0
kind: ConformanceReport
mode: default
profiles:
- core:
result: partial
skippedTests:
- GatewaySecretInvalidReferenceGrant
- GatewaySecretMissingReferenceGrant
- HTTPRouteHTTPSListener
- HTTPRouteInvalidCrossNamespaceBackendRef
- HTTPRouteInvalidReferenceGrant
- HTTPRoutePartiallyInvalidViaInvalidReferenceGrant
- HTTPRouteReferenceGrant
statistics:
Failed: 0
Passed: 26
Skipped: 7
name: GATEWAY-HTTP
summary: Core tests partially succeeded with 7 test skips. |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enriches CRD documentation by adding detailed descriptions for spec and individual fields across the API reference, YAML schemas, and Go type comments.
- Expanded
specdefinitions indocs/crd/api.mdfor all CRD kinds - Added or refined field descriptions in
config/crd/bases/*.yaml - Synchronized Go doc comments in
api/v1alpha1/*_types.gowith the YAML and markdown docs
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/crd/api.md | Added detailed spec descriptions for each CRD kind |
| config/crd/bases/apisix.apache.org_pluginconfigs.yaml | Defined spec and field descriptions for PluginConfig |
| config/crd/bases/apisix.apache.org_httproutepolicies.yaml | Enhanced YAML docs with priority and vars descriptions |
| config/crd/bases/apisix.apache.org_gatewayproxies.yaml | Added pluginMetadata, plugins, provider, and status docs |
| config/crd/bases/apisix.apache.org_consumers.yaml | Documented credentials, gatewayRef, and plugin fields |
| config/crd/bases/apisix.apache.org_backendtrafficpolicies.yaml | Added descriptions for load balancing, retries, timeouts, etc. |
| api/v1alpha1/pluginconfig_types.go | Updated doc comments for PluginConfig and Plugin |
| api/v1alpha1/httproutepolicy_types.go | Refined comments for HTTPRoutePolicySpec and Spec in the struct |
| api/v1alpha1/gatewayproxy_types.go | Synchronized Go comments for GatewayProxy and related types |
| api/v1alpha1/consumer_types.go | Added Go doc comments for ConsumerSpec, GatewayRef, Credential |
| api/v1alpha1/backendtrafficpolicy_types.go | Updated comments for BackendTrafficPolicySpec and related types |
Co-authored-by: Copilot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Type of change:
What this PR does / why we need it:
Update comments for CRD docs generation.
TODO: valid column
Pre-submission checklist: